CuDoubleSidedScannerAPI  1.11
Custom.CuDoubleSidedScannerAPIWrap.CuScanner Class Reference

Class that manages Scanner data and communication. More...

Public Types

enum  ScannerEjectType
 Eject type: which operation the paper form will perform during or after the scan job More...
 
enum  ScannerPrintDensity
 Scanner print density. Only for scanners that support print option More...
 

Public Member Functions

CuScannerStatus GetStatus ()
 Returns the current scanner status.
More...
 
String GetFirmwareRelease ()
 Gets the current firmware release More...
 
String GetHardwareRelease ()
 Gets the current hardware release More...
 
String GetModelRelease ()
 Gets the current scanner model and release More...
 
UInt32 GetVoidPrintedPaperLen ()
 Get the lenght, in cm, of the total printed paper during "void" operations. (only for scanners with print option) More...
 
UInt32 GetScanCounter ()
 Get the number of the total scan jobs performed by the scanner. (only for scanners with print option) More...
 
Byte [] GetMagneticData ()
 Gets magnetic ink characters for CMC 7 standard. Scanner decodes magnetic data during a scan job More...
 
void TicketEject (ScannerEjectType ejectType)
 */ More...
 
void LoadPaper ()
 Loads a ticket More...
 
CImagesFromScannerContainer ScanAndGetImage (CuScanParameters parameters)
 Starts a scan job and gets the scanned image More...
 
Boolean CheckScanParameters (CuScanParameters parameters)
 Checks if all the scan parameters are ok for this device. More...
 
void ResetScanner ()
 Performs an hardware scanner reset. Returns when the scanner is online More...
 
ScannerCapability GetScannerCapability ()
 Gets the scanner capabilities More...
 
ScannerUltrasonicParameters GetUltrasonicParameters ()
 Gets the scanner ultrasonic parameters (if supported by the device) from the RAM. More...
 
void SetUltrasonicParameters (ScannerUltrasonicParameters uparams)
 Sets the scanner ultrasonic parameters (if supported by the device) into the RAM. More...
 
CropParameters GetCropParameters ()
 Gets the crop parameters. More...
 
void SetCropParameters (CropParameters cparams)
 Sets the crop parameters. More...
 
void SetLedSettings (LedBarSetting ledSetting)
 Set led bar working parameters More...
 
void UpdateScannerFirmware (String filePathAndName, Boolean checkFileValidity)
 Performs a firmware update. This operation culd take several seconds. Don't call other scanner API during this operation. Returns when the scanner is online More...
 
void VoidTicketWithBitmap (Bitmap bBitmap, UInt32 offsetSteps, ScannerEjectType movementAfterVoid, ScannerPrintDensity printDensity)
 Void / Brand the ticket with a Bitmap. (only for scanners with print option) More...
 
void SetBWThreshold (Byte bBWThreshold)
 Sets the Threshold value for Black & White conversion More...
 
Byte GetBWThreshold ()
 Gets the Threshold value for Black & White conversion More...
 
void SetRejectMargins (Byte bRejectMarginL, Byte bRejectMarginR)
 Sets the Reject Margins More...
 
void SetColorGammaCurvesCorrection (ColorGammaCurvesSetting colorGammaCurvesSetting)
 Sets the Color Gamma Curves More...
 
void SetColorGammaCorrection (ColorGammaSetting colorGammaSetting)
 Sets the Color Gamma (Works only with A4_Scanner) More...
 

Detailed Description

Class that manages Scanner data and communication.

Member Enumeration Documentation

◆ ScannerEjectType

Eject type: which operation the paper form will perform during or after the scan job

Enumerator
HOLD_TICKET 

The scanned form will be hold by the scanner

MOVE_FORWARD 

The scanned form will be ejected, moved over the scanner

MOVE_BACKWARD 

The scanned form will return back to the user

◆ ScannerPrintDensity

Scanner print density. Only for scanners that support print option

Enumerator
DENSITY_M50 

Print Density –50%

DENSITY_M37 

Print Density –37%

DENSITY_M25 

Print Density –25%

DENSITY_M12 

Print Density –12%

DENSITY_NORMAL 

Print Density 0%

DENSITY_P12 

Print Density +12%

DENSITY_P25 

Print Density +25%

DENSITY_P37 

Print Density +37%

DENSITY_P50 

Print Density +50%

DENSITY_NOT_SET 

Not set by the library

Member Function Documentation

◆ CheckScanParameters()

Boolean Custom.CuDoubleSidedScannerAPIWrap.CuScanner.CheckScanParameters ( CuScanParameters  parameters)
inline

Checks if all the scan parameters are ok for this device.

Parameters
parametersA CuScanParameters object that contains all scan parameters.
Returns
True if all the parameters are ok, otherwise false.
Exceptions
CuDoubleSidedScannerException

◆ GetBWThreshold()

Byte Custom.CuDoubleSidedScannerAPIWrap.CuScanner.GetBWThreshold ( )
inline

Gets the Threshold value for Black & White conversion

Exceptions
CeScannerCommException

◆ GetCropParameters()

CropParameters Custom.CuDoubleSidedScannerAPIWrap.CuScanner.GetCropParameters ( )
inline

Gets the crop parameters.

Returns
A CropParameters object containing the crop parameters
Exceptions
CuDoubleSidedScannerException

◆ GetFirmwareRelease()

String Custom.CuDoubleSidedScannerAPIWrap.CuScanner.GetFirmwareRelease ( )
inline

Gets the current firmware release

Returns
A String containing the scanner firmware release
Exceptions
CuDoubleSidedScannerException

◆ GetHardwareRelease()

String Custom.CuDoubleSidedScannerAPIWrap.CuScanner.GetHardwareRelease ( )
inline

Gets the current hardware release

Returns
A String containing the scanner hardware release
Exceptions
CuDoubleSidedScannerException

◆ GetMagneticData()

Byte [] Custom.CuDoubleSidedScannerAPIWrap.CuScanner.GetMagneticData ( )
inline

Gets magnetic ink characters for CMC 7 standard. Scanner decodes magnetic data during a scan job

Returns
A Byte array containing the read magnetic data
Exceptions
CuDoubleSidedScannerException

◆ GetModelRelease()

String Custom.CuDoubleSidedScannerAPIWrap.CuScanner.GetModelRelease ( )
inline

Gets the current scanner model and release

Returns
A String containing the scanner model and release
Exceptions
CuDoubleSidedScannerException

◆ GetScanCounter()

UInt32 Custom.CuDoubleSidedScannerAPIWrap.CuScanner.GetScanCounter ( )
inline

Get the number of the total scan jobs performed by the scanner. (only for scanners with print option)

Returns
The number of total performed scan jobs
Exceptions
CuDoubleSidedScannerException

◆ GetScannerCapability()

ScannerCapability Custom.CuDoubleSidedScannerAPIWrap.CuScanner.GetScannerCapability ( )
inline

Gets the scanner capabilities

Returns
A ScannerCapability object containing the scanner capabilities
Exceptions
CuDoubleSidedScannerException

◆ GetStatus()

CuScannerStatus Custom.CuDoubleSidedScannerAPIWrap.CuScanner.GetStatus ( )
inline

Returns the current scanner status.

Returns
The current scanner status
Exceptions
CuDoubleSidedScannerException

◆ GetUltrasonicParameters()

ScannerUltrasonicParameters Custom.CuDoubleSidedScannerAPIWrap.CuScanner.GetUltrasonicParameters ( )
inline

Gets the scanner ultrasonic parameters (if supported by the device) from the RAM.

Returns
A ScannerUltrasonicParameters object containing the ultrasonic parameters
Exceptions
CuDoubleSidedScannerException

◆ GetVoidPrintedPaperLen()

UInt32 Custom.CuDoubleSidedScannerAPIWrap.CuScanner.GetVoidPrintedPaperLen ( )
inline

Get the lenght, in cm, of the total printed paper during "void" operations. (only for scanners with print option)

Returns
The total amount, in cm, of printed paper
Exceptions
CuDoubleSidedScannerException

◆ LoadPaper()

void Custom.CuDoubleSidedScannerAPIWrap.CuScanner.LoadPaper ( )
inline

Loads a ticket

Exceptions
CuDoubleSidedScannerException

◆ ResetScanner()

void Custom.CuDoubleSidedScannerAPIWrap.CuScanner.ResetScanner ( )
inline

Performs an hardware scanner reset. Returns when the scanner is online

Exceptions
CuDoubleSidedScannerException

◆ ScanAndGetImage()

CImagesFromScannerContainer Custom.CuDoubleSidedScannerAPIWrap.CuScanner.ScanAndGetImage ( CuScanParameters  parameters)
inline

Starts a scan job and gets the scanned image

Parameters
parametersA CuScanParameters object that contains all scan parameters.
Returns
a CImagesFromScannerContainer containig the scanned image (if one scan side has been selected), or two images (if both scan sides have been selected).
Exceptions
CuDoubleSidedScannerException

◆ SetBWThreshold()

void Custom.CuDoubleSidedScannerAPIWrap.CuScanner.SetBWThreshold ( Byte  bBWThreshold)
inline

Sets the Threshold value for Black & White conversion

Parameters
bBWThresholdBlack & White Threshold.
Exceptions
CeScannerCommException

◆ SetColorGammaCorrection()

void Custom.CuDoubleSidedScannerAPIWrap.CuScanner.SetColorGammaCorrection ( ColorGammaSetting  colorGammaSetting)
inline

Sets the Color Gamma (Works only with A4_Scanner)

Parameters
colorGammaSettingClass with the paramethers for set the Gamma Correction.
Exceptions
CeScannerCommException

◆ SetColorGammaCurvesCorrection()

void Custom.CuDoubleSidedScannerAPIWrap.CuScanner.SetColorGammaCurvesCorrection ( ColorGammaCurvesSetting  colorGammaCurvesSetting)
inline

Sets the Color Gamma Curves

Parameters
colorGammaCurvesSettingClass with the paramethers for set the Gamma Correction.
Exceptions
CeScannerCommException

◆ SetCropParameters()

void Custom.CuDoubleSidedScannerAPIWrap.CuScanner.SetCropParameters ( CropParameters  cparams)
inline

Sets the crop parameters.

Parameters
cparamsA CropParameters object that contains the crop parameters to sets.
Exceptions
CuDoubleSidedScannerException

◆ SetLedSettings()

void Custom.CuDoubleSidedScannerAPIWrap.CuScanner.SetLedSettings ( LedBarSetting  ledSetting)
inline

Set led bar working parameters

Parameters
ledSettingLed settings to be set for led bar.
Exceptions
CuDoubleSidedScannerException

◆ SetRejectMargins()

void Custom.CuDoubleSidedScannerAPIWrap.CuScanner.SetRejectMargins ( Byte  bRejectMarginL,
Byte  bRejectMarginR 
)
inline

Sets the Reject Margins

Parameters
bRejectMarginLLeft Margin for Reject. Each step corresponds to 32pixels.The value must be in the range 0-15 (0 default).
Parameters
bRejectMarginRRight Margin for Reject. Each step corresponds to 32pixels.The value must be in the range 0-15 (0 default).
Exceptions
CeScannerCommException

◆ SetUltrasonicParameters()

void Custom.CuDoubleSidedScannerAPIWrap.CuScanner.SetUltrasonicParameters ( ScannerUltrasonicParameters  uparams)
inline

Sets the scanner ultrasonic parameters (if supported by the device) into the RAM.

Parameters
uparamsA ScannerUltrasonicParameters object that contains the ultrasonic parameters to sets.
Exceptions
CuDoubleSidedScannerException

◆ TicketEject()

void Custom.CuDoubleSidedScannerAPIWrap.CuScanner.TicketEject ( ScannerEjectType  ejectType)
inline

*/

Performs a ticket eject or retract

Parameters
ejectTypeEject type: select whether to eject (move over the scanner) or retract (move back to the user) the ticket
Exceptions
CuDoubleSidedScannerException

◆ UpdateScannerFirmware()

void Custom.CuDoubleSidedScannerAPIWrap.CuScanner.UpdateScannerFirmware ( String  filePathAndName,
Boolean  checkFileValidity 
)
inline

Performs a firmware update. This operation culd take several seconds. Don't call other scanner API during this operation. Returns when the scanner is online

Parameters
filePathAndNameUpdate file name and path
checkFileValidityIf true, the API will check the file validity before start update the firmware. Using true is ADVISED. Use false only when strictly necessary.
Exceptions
CuDoubleSidedScannerException

◆ VoidTicketWithBitmap()

void Custom.CuDoubleSidedScannerAPIWrap.CuScanner.VoidTicketWithBitmap ( Bitmap  bBitmap,
UInt32  offsetSteps,
ScannerEjectType  movementAfterVoid,
ScannerPrintDensity  printDensity 
)
inline

Void / Brand the ticket with a Bitmap. (only for scanners with print option)

Parameters
bBitmapBitmap image to print
Parameters
offsetStepsOffset to perform before to print, in dots
Parameters
movementAfterVoidThe movement the ticket must perform after being voided: to be ejected forward, retracted backward, or kept hold for further commands by the user
printDensityPrint Density
Exceptions
CeScannerCommException